Contents of Option declaration

Option declaration

The following commands deal with the declaration and handling of options to document classes and packages.

There are some commands designed especially for use within the code argument of these commands (see below).

$\begin{decl} \vert\DeclareOption\vert \arg{option-name} \arg{code} \end{decl}$
This makes option-name a `declared option' of the class or package in which it is put.

The code argument contains the code to be executed if that option is specified for the class or package; it can contain any valid L^ATEX2_e construct.

Example:

   \DeclareOption{twoside}{\@twosidetrue}

$\begin{decl} \vert\DeclareOption*\vert \arg{code} \end{decl}$
This declares the code to be executed for every option which is specified for, but otherwise not explicitly declared by, the class or package; this code is called the `default option code' and it can contain any valid L^ATEX2_e construct.

If a class file contains no || then, by default, all specified but undeclared options for that class will be silently passed to all packages (as will the specified and declared options for that class).

If a package file contains no || then, by default, each specified but undeclared option for that package will produce an error.